SubmitExternalSrcConfirmation Merchant

This operation submits an SRC confirmation for a transaction processed by a PSP other than MPGS.

POST https://test-bankalfalah.gateway.mastercard.com/api/rest/version/75 / merchant / {merchantId}

Authentication

This operation requires authentication via one of the following methods:


  • Certificate authentication.
  • Basic HTTP authentication as described at w3.org. Provide 'merchant.<your gateway merchant ID>' in the userid portion and your API password in the password portion.

Request

URL Parameters

{merchantId} Alphanumeric + additional characters REQUIRED

The unique identifier issued to you by your payment provider.


This identifier can be up to 12 characters in length.


Data may consist of the characters 0-9, a-z, A-Z, '-', '_'

Min length: 1 Max length: 40

Fields

apiOperation String = SUBMIT_EXTERNAL_SRC_CONFIRMATION FIXED

Any sequence of zero or more unicode characters.

confirmationData REQUIRED

Provide the details for the confirmation data.

confirmationData.checkoutEventType Enumeration REQUIRED

Event type associated with the update.

Format: It is one of the following values:AUTHORIZE The transaction performed outside the MPGS gateway is an AUTHORIZATION transaction. REFUND The transaction performed outside the MPGS gateway is a REFUND transaction. CANCEL The transaction performed outside the MPGS gateway is a CANCEL transaction.

Value must be a member of the following list. The values are case sensitive.

AUTHORIZE

AUTHORIZE

CANCEL

CANCEL

REFUND

REFUND

confirmationData.confirmationStatus Enumeration REQUIRED

AUTHORIZE The transaction performed outside the MPGS gateway is an AUTHORIZATION transaction.

REFUND The transaction performed outside the MPGS gateway is a REFUND transaction. CANCEL The transaction performed outside the MPGS gateway is a CANCEL transaction.

Value must be a member of the following list. The values are case sensitive.

FAILURE

FAILURE

SUCCESS

SUCCESS

confirmationData.confirmationTimestamp String REQUIRED

UTC Date and time (ISO 8601) of the event completion corresponding to the Confirmation event by SRC Initiator.

Example, 2020-02-26T10:31:47Z.

Data can consist of any characters

Min length: 1 Max length: 40
confirmationData.networkAuthorizationCode String REQUIRED

Indicates the code of the financial network that was used to process the transaction with the issuer.

(MC,AMEX, VISA)

Data can consist of any characters

Min length: 1 Max length: 25
confirmationData.networkCode String REQUIRED

Value generated by the issuing bank in response to a proposal to transfer funds.

Data can consist of any characters

Min length: 1 Max length: 25
confirmationData.networkTransactionIdentifier String REQUIRED

The unique identifier for the transaction returned by the issuer.

(MC,AMEX, VISA)

Data can consist of any characters

Min length: 1 Max length: 25
confirmationData.paymentNetworkReference String REQUIRED

Reference of the payment network

Data can consist of any characters

Min length: 1 Max length: 40
correlationId String OPTIONAL

A transient identifier for the request, that can be used to match the response to the request.

The value provided is not validated, does not persist in the gateway, and is returned as provided in the response to the request.

Data can consist of any characters

Min length: 1 Max length: 100
gatewayEntryPoint String REQUIRED

The interface through which the transaction is submitted to the gateway.

Data can consist of any characters

Min length: 1 Max length: 40
serviceId String REQUIRED

Unique service identifier

Data can consist of any characters

Min length: 1 Max length: 40
transaction REQUIRED

Provide the details for the transaction.

transaction.amount Decimal REQUIRED

The total amount for the transaction.

Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.

Min length: 1 Max length: 13 Max post-decimal digits: 3
transaction.currency String REQUIRED

The currency of the transaction expressed as an ISO 4217 alpha code, e.g. USD.

Data can consist of any characters

Min length: 3 Max length: 3
wallet REQUIRED

Provide the details for the Wallet.

Response

Fields

correlationId String CONDITIONAL

A transient identifier for the request, that can be used to match the response to the request.

The value provided is not validated, does not persist in the gateway, and is returned as provided in the response to the request.

Data can consist of any characters

Min length: 1 Max length: 100
result Boolean ALWAYS PROVIDED

Result of the process

JSON boolean values 'true' or 'false'.

Errors

error

Information on possible error conditions that may occur while processing an operation using the API.

error.cause Enumeration

Broadly categorizes the cause of the error.

For example, errors may occur due to invalid requests or internal system failures.

Value must be a member of the following list. The values are case sensitive.

INVALID_REQUEST

The request was rejected because it did not conform to the API protocol.

REQUEST_REJECTED

The request was rejected due to security reasons such as firewall rules, expired certificate, etc.

SERVER_BUSY

The server did not have enough resources to process the request at the moment.

SERVER_FAILED

There was an internal system failure.

error.explanation String

Textual description of the error based on the cause.

This field is returned only if the cause is INVALID_REQUEST or SERVER_BUSY.

Data can consist of any characters

Min length: 1 Max length: 1000
error.field String

Indicates the name of the field that failed validation.

This field is returned only if the cause is INVALID_REQUEST and a field level validation error was encountered.

Data can consist of any characters

Min length: 1 Max length: 100
error.supportCode String

Indicates the code that helps the support team to quickly identify the exact cause of the error.

This field is returned only if the cause is SERVER_FAILED or REQUEST_REJECTED.

Data can consist of any characters

Min length: 1 Max length: 100
error.validationType Enumeration

Indicates the type of field validation error.

This field is returned only if the cause is INVALID_REQUEST and a field level validation error was encountered.

Value must be a member of the following list. The values are case sensitive.

INVALID

The request contained a field with a value that did not pass validation.

MISSING

The request was missing a mandatory field.

UNSUPPORTED

The request contained a field that is unsupported.

result Enumeration

A system-generated high level overall result of the operation.

Value must be a member of the following list. The values are case sensitive.

ERROR

The operation resulted in an error and hence cannot be processed.